Developer Documentation

QuickTime 4 API Documentation

3D Graphics Programming with QuickDraw 3D 1.5.4

Previous | QD3D Book | Overview | Chapter Contents | Next |

Viewer Flags

When you create a new viewer object (by calling Q3ViewerNew ), you need to specify a set of viewer flags that control various aspects of the new viewer object.

All flags with values greater than or equal to kQ3ViewerButtonReset were introduced in version 1.1 of the 3D Viewer. In addition, the value of the flag kQ3ViewerDefault is different in version 1.0 than in all later versions.

enum {
    kQ3ViewerShowBadge                  = 1<<0,
    kQ3ViewerActive                     = 1<<1,
    kQ3ViewerControllerVisible          = 1<<2,
    kQ3ViewerDrawFrame                  = 1<<3,
    kQ3ViewerDraggingOff                = 1<<4,
    kQ3ViewerButtonCamera               = 1<<5,
    kQ3ViewerButtonTruck                = 1<<6,
    kQ3ViewerButtonOrbit                = 1<<7,
    kQ3ViewerButtonZoom                 = 1<<8,
    kQ3ViewerButtonDolly                = 1<<9,
    kQ3ViewerButtonReset                = 1<<10,
    kQ3ViewerOutputTextMode             = 1<<11,
    kQ3ViewerDragMode                   = 1<<12,
    kQ3ViewerDrawGrowBox                = 1<<13,
    kQ3ViewerDrawDragBorder             = 1<<14,
    kQ3ViewerDraggingInOff              = 1<<15,
    kQ3ViewerDraggingOutOff             = 1<<16,
    kQ3ViewerDefault                    = 1<<31
};

Constant descriptions

kQ3ViewerShowBadge
If this flag is set, a badge is displayed in the viewer pane whenever the controller strip is not visible. See "Badges" for complete details on when the badge appears and disappears. If this flag is clear, no badge is displayed. By default, this flag is clear.
kQ3ViewerActive
If this flag is set, the viewer object is active. If this flag is clear, the viewer object is inactive and the controller strip, if displayed, is dimmed. By default, this flag is set.
kQ3ViewerControllerVisible
If this flag is set, the controller strip is visible. If this flag is clear, the controller strip is not visible. If the kQ3ViewerShowBadge flag is set, the controller strip should be made invisible by clearing this flag. By default, this flag is set.
kQ3ViewerDrawFrame
If this flag is set, a one-pixel frame is drawn within the viewer pane. If this flag is clear, no frame is drawn within the viewer pane. By default, this flag is clear.
kQ3ViewerDraggingOff
If this flag is set, drag and drop is turned off in the viewer pane (that is, both dragging out of the viewer pane and dragging into the viewer pane are disabled). You can also independently set the states for dragging out and dragging in, by using the kQ3ViewerDraggingOutOff and kQ3ViewerDraggingInOff flags. By default, this flag is clear.
kQ3ViewerButtonCamera
If this flag is set, the camera viewpoint control in the controller strip is displayed. By default, this flag is set.
kQ3ViewerButtonTruck
If this flag is set, the distance button in the controller strip is displayed. By default, this flag is set.
kQ3ViewerButtonOrbit
If this flag is set, the rotate button in the controller strip is displayed. By default, this flag is set.
kQ3ViewerButtonZoom
If this flag is set, the zoom button in the controller strip is displayed. By default, this flag is clear.
kQ3ViewerButtonDolly
If this flag is set, the move button in the controller strip is displayed. By default, this flag is set.
kQ3ViewerButtonReset
If this flag is set, the reset button in the controller strip is displayed. By default, this flag is set.
kQ3ViewerOutputTextMode
If this flag is set, the Q3ViewerWriteFile function writes 3DMF files in text format (not in binary format). By default, this flag is clear.
kQ3ViewerDragMode
If this flag is set, the viewer object is in drag and drop mode, where the viewer responds only to drag and drop interaction. By default, this flag is clear.
kQ3ViewerDrawGrowBox
If this flag is set, the 3D Viewer draws a grow box in the lower-right corner of the viewer pane. By default, this flag is clear.
kQ3ViewerDrawDragBorder
If this flag is set, the 3D Viewer draws a drag border around the perimeter of the viewer pane. When the user clicks on the border and drags, a drag operation is initiated. By default, this flag is set.
kQ3ViewerDraggingInOff
If this flag is set, dragging into the viewer pane is disabled. By default, this flag is clear.
kQ3ViewerDraggingOutOff
If this flag is set, dragging out of the viewer pane is disabled. By default, this flag is clear.
kQ3ViewerDefault
The default configuration for a viewer object.

Applications that were compiled using version 1.0 of the 3D Viewer and that specify the kQ3ViewerDefault value when creating a view object (or resetting a viewer's flags) will be configured using the default flags defined for version 1.0, regardless of the version of the 3D Viewer installed. You must recompile your application using the interface file and shared library for version 1.1 or later the 3D Viewer to receive the new default behavior.


© 1997 Apple Computer, Inc.

Previous | QD3D Book | Overview | Chapter Contents | Next |